package com.heima.tlias.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
//开启swagger功能
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {

        List<Parameter> pars = new ArrayList<>();

        //header中的token参数非必填，传空也可以
        Parameter parameter = new ParameterBuilder()
                .name("token")
                .defaultValue("eyJhbGciOiJIUzUxMiJ9.eyJpZCI6MSwibmFtZSI6IuWwj-eOiyIsImV4cCI6MTcxNzkzODUwNH0.AW4BdIiJObPm6sQ-tZirJFH5M7LUxy8RI8R2WbdigwVHrteGPSv3EhvcjMEP-whU_u0TueKbk2jWhayURUf9dw")
                .description("请求接口所需Token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                //false非必输 true必输
                .required(false)
                .build();
        pars.add(parameter);

        return new Docket(DocumentationType.SWAGGER_2)
                // 用于生成API信息
                .apiInfo(apiInfo())
                // select()函数返回一个ApiSelectorBuilder实例,用来控制接口被swagger做成文档
                .select()
                // 用于指定扫描哪个包下的接口
                .apis(RequestHandlerSelectors.basePackage("com.heima.tlias.controller"))
                // 选择所有的API,如果你想只为部分API生成文档，可以配置这里
                .paths(PathSelectors.any())
                .build().globalOperationParameters(pars);
    }

    /**
     * 用于定义API主界面的信息，比如可以声明所有的API的总标题、描述、版本
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //  可以用来自定义API的主标题
                .title("tlias智能学习辅助系统API")
                // 可以用来描述整体的API
                .description("tlias智能学习辅助系统API接口文档")
                // 可以用来定义版本
                .version("1.0")
                .build();
    }
}